package com.train.common.report.service;

import com.train.common.core.base.service.IBaseService;
import com.train.common.dbutil.object.SqlTableColumn;
import com.train.common.report.model.ReportDblink;

import java.util.List;

/**
 * 数据库链接数据操作服务接口。
 *
 * @author xulei
 * @date 2025-03-07
 */
public interface ReportDblinkService extends IBaseService<ReportDblink, Long> {

    /**
     * 保存新增对象。
     *
     * @param reportDblink 新增对象。
     * @return 返回新增对象。
     */
    ReportDblink saveNew(ReportDblink reportDblink);

    /**
     * 更新数据对象。
     *
     * @param reportDblink         更新的对象。
     * @param originalReportDblink 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(ReportDblink reportDblink, ReportDblink originalReportDblink);

    /**
     * 删除指定数据。
     *
     * @param dblinkId 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long dblinkId);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getReportDblinkListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<ReportDblink> getReportDblinkList(ReportDblink filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getReportDblinkList)，以便获取更好的查询性能。
     *
     * @param filter 主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<ReportDblink> getReportDblinkListWithRelation(ReportDblink filter, String orderBy);

    /**
     * 获取指定数据库链接下的所有数据表。
     * @param reportDblink 数据库链接对象。
     * @return 数据表名列表。
     */
    List<String> getAllTables(ReportDblink reportDblink);

    /**
     * 获取指定数据库链接下指定表的字段列表。
     *
     * @param reportDblink 数据库链接对象。
     * @param tableName    表名称。
     * @return 指定表的字段列表。
     */
    List<SqlTableColumn> getTableColumnList(ReportDblink reportDblink, String tableName);
}
